<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<head>
    <title>Reference</title>
    <link rel="stylesheet" href="../ldoc.css" type="text/css" />
</head>
<body>

<div id="container">

<div id="product">
	<div id="product_logo"></div>
	<div id="product_name"><big><b></b></big></div>
	<div id="product_description"></div>
</div> <!-- id="product" -->


<div id="main">


<!-- Menu -->

<div id="navigation">
<br/>
<h1>Duplex</h1>

<ul>
  <li><a href="../index.html">Index</a></li>
</ul>

<h2>Contents</h2>
<ul>
<li><a href="#Tables">Tables</a></li>
<li><a href="#Fields">Fields</a></li>
</ul>


<h2>Modules</h2>
<ul class="$(kind=='Topics' and '' or 'nowrap'">
  <li><a href="../modules/Duplex.Application.html">Duplex.Application</a></li>
  <li><a href="../modules/Duplex.Applications.Effect.html">Duplex.Applications.Effect</a></li>
  <li><a href="../modules/Duplex.Applications.GridPie.html">Duplex.Applications.GridPie</a></li>
  <li><a href="../modules/Duplex.Applications.Hydra.html">Duplex.Applications.Hydra</a></li>
  <li><a href="../modules/Duplex.Applications.Instrument.html">Duplex.Applications.Instrument</a></li>
  <li><a href="../modules/Duplex.Applications.Keyboard.GridLayout.html">Duplex.Applications.Keyboard.GridLayout</a></li>
  <li><a href="../modules/Duplex.Applications.Keyboard.Layouts.HarmonicLayout.html">Duplex.Applications.Keyboard.Layouts.HarmonicLayout</a></li>
  <li><a href="../modules/Duplex.Applications.Keyboard.Layouts.IsomorphicLayout.html">Duplex.Applications.Keyboard.Layouts.IsomorphicLayout</a></li>
  <li><a href="../modules/Duplex.Applications.Keyboard.Layouts.PianoLayout.html">Duplex.Applications.Keyboard.Layouts.PianoLayout</a></li>
  <li><a href="../modules/Duplex.Applications.Keyboard.html">Duplex.Applications.Keyboard</a></li>
  <li><a href="../modules/Duplex.Applications.Matrix.html">Duplex.Applications.Matrix</a></li>
  <li><a href="../modules/Duplex.Applications.Metronome.html">Duplex.Applications.Metronome</a></li>
  <li><a href="../modules/Duplex.Applications.MidiActions.Bindings.html">Duplex.Applications.MidiActions.Bindings</a></li>
  <li><a href="../modules/Duplex.Applications.MidiActions.html">Duplex.Applications.MidiActions</a></li>
  <li><a href="../modules/Duplex.Applications.Mixer.html">Duplex.Applications.Mixer</a></li>
  <li><a href="../modules/Duplex.Applications.Mlrx.Mlrx_group.html">Duplex.Applications.Mlrx.Mlrx_group</a></li>
  <li><a href="../modules/Duplex.Applications.Mlrx.Mlrx_note.html">Duplex.Applications.Mlrx.Mlrx_note</a></li>
  <li><a href="../modules/Duplex.Applications.Mlrx.Mlrx_pos.html">Duplex.Applications.Mlrx.Mlrx_pos</a></li>
  <li><a href="../modules/Duplex.Applications.Mlrx.Mlrx_track.html">Duplex.Applications.Mlrx.Mlrx_track</a></li>
  <li><a href="../modules/Duplex.Applications.Mlrx.html">Duplex.Applications.Mlrx</a></li>
  <li><a href="../modules/Duplex.Applications.Navigator.html">Duplex.Applications.Navigator</a></li>
  <li><a href="../modules/Duplex.Applications.NotesOnWheels.html">Duplex.Applications.NotesOnWheels</a></li>
  <li><a href="../modules/Duplex.Applications.PatternCursor.html">Duplex.Applications.PatternCursor</a></li>
  <li><a href="../modules/Duplex.Applications.PatternSequence.html">Duplex.Applications.PatternSequence</a></li>
  <li><a href="../modules/Duplex.Applications.Recorder.html">Duplex.Applications.Recorder</a></li>
  <li><a href="../modules/Duplex.Applications.Repeater.html">Duplex.Applications.Repeater</a></li>
  <li><a href="../modules/Duplex.Applications.Rotate.html">Duplex.Applications.Rotate</a></li>
  <li><a href="../modules/Duplex.Applications.StepSequencer.html">Duplex.Applications.StepSequencer</a></li>
  <li><a href="../modules/Duplex.Applications.SwitchConfiguration.html">Duplex.Applications.SwitchConfiguration</a></li>
  <li><a href="../modules/Duplex.Applications.TestPad.html">Duplex.Applications.TestPad</a></li>
  <li><a href="../modules/Duplex.Applications.TrackSelector.html">Duplex.Applications.TrackSelector</a></li>
  <li><a href="../modules/Duplex.Applications.Transport.html">Duplex.Applications.Transport</a></li>
  <li><a href="../modules/Duplex.Applications.UIButtonTest.html">Duplex.Applications.UIButtonTest</a></li>
  <li><a href="../modules/Duplex.Applications.XYPad.html">Duplex.Applications.XYPad</a></li>
  <li><a href="../modules/Duplex.Automation.html">Duplex.Automation</a></li>
  <li><a href="../modules/Duplex.Browser.html">Duplex.Browser</a></li>
  <li><a href="../modules/Duplex.BrowserProcess.html">Duplex.BrowserProcess</a></li>
  <li><a href="../modules/Duplex.Canvas.html">Duplex.Canvas</a></li>
  <li><a href="../modules/Duplex.CanvasPoint.html">Duplex.CanvasPoint</a></li>
  <li><a href="../modules/Duplex.ControlMap.html">Duplex.ControlMap</a></li>
  <li><a href="../modules/Duplex.Device.html">Duplex.Device</a></li>
  <li><a href="../modules/Duplex.Display.html">Duplex.Display</a></li>
  <li><a href="../modules/Duplex.Globals.html">Duplex.Globals</a></li>
  <li><a href="../modules/Duplex.Message.html">Duplex.Message</a></li>
  <li><a href="../modules/Duplex.MessageStream.html">Duplex.MessageStream</a></li>
  <li><a href="../modules/Duplex.MidiDevice.html">Duplex.MidiDevice</a></li>
  <li><a href="../modules/Duplex.OscClient.html">Duplex.OscClient</a></li>
  <li><a href="../modules/Duplex.OscDevice.html">Duplex.OscDevice</a></li>
  <li><a href="../modules/Duplex.OscVoiceMgr.html">Duplex.OscVoiceMgr</a></li>
  <li><strong>Duplex.Preferences</strong></li>
  <li><a href="../modules/Duplex.ProcessSlicer.html">Duplex.ProcessSlicer</a></li>
  <li><a href="../modules/Duplex.RoamingDSP.html">Duplex.RoamingDSP</a></li>
  <li><a href="../modules/Duplex.Scheduler.html">Duplex.Scheduler</a></li>
  <li><a href="../modules/Duplex.StateController.html">Duplex.StateController</a></li>
  <li><a href="../modules/Duplex.UIButton.html">Duplex.UIButton</a></li>
  <li><a href="../modules/Duplex.UIButtonStrip.html">Duplex.UIButtonStrip</a></li>
  <li><a href="../modules/Duplex.UIComponent.html">Duplex.UIComponent</a></li>
  <li><a href="../modules/Duplex.UIKey.html">Duplex.UIKey</a></li>
  <li><a href="../modules/Duplex.UIKeyPressure.html">Duplex.UIKeyPressure</a></li>
  <li><a href="../modules/Duplex.UILabel.html">Duplex.UILabel</a></li>
  <li><a href="../modules/Duplex.UIPad.html">Duplex.UIPad</a></li>
  <li><a href="../modules/Duplex.UIPitchBend.html">Duplex.UIPitchBend</a></li>
  <li><a href="../modules/Duplex.UISlider.html">Duplex.UISlider</a></li>
  <li><a href="../modules/Duplex.UISpinner.html">Duplex.UISpinner</a></li>
  <li><a href="../modules/Duplex.WidgetHooks.html">Duplex.WidgetHooks</a></li>
  <li><a href="../modules/Duplex.WidgetKeyboard.html">Duplex.WidgetKeyboard</a></li>
  <li><a href="../modules/Duplex.html">Duplex</a></li>
  <li><a href="../modules/main.html">main</a></li>
</ul>

</div>

<div id="content">

<h1>Module <code>Duplex.Preferences</code></h1>
<p>Manage global settings or individual device-configuration settings for Duplex</p>

<p>Device and application setup for controllers are registered by the controllers itself.</p>
<p> Each entry is a file located in the Controllers/Configuration subfolder, and must have the following properties defined:</p>

<pre><code>{
 ** configuration properties
 name = "Some Config", -- config name as visible in the browser
 pinned = true, -- when true, config is added to the Duplex context menu

 ** device properties
 device = {
   class_name = nil, -- optional custom device class
   display_name = "Some Device", -- as visible in the browser
   device_name = "Some Device", -- MIDI device name
   control_map = "controlmap.xml", -- path &amp; name of the control map
   protocol = DEVICE_PROTOCOL.MIDI
 },

 ** applications
 applications = { -- list of applications and app configs
   Mixer = { options = "Something" }, -- a mixer app
   Effect = { options = "Something" } -- an effect app
 }
}
</code></pre>

<p>Once defined, the configuration will be shown in the browser by it's device name   </p>


<h2><a href="#Tables">Tables</a></h2>
<table class="function_list">
	<tr>
	<td class="name" nowrap><a href="#theme_color">theme_color</a></td>
	<td class="summary">(table) theming support: specify the default button color</td>
	</tr>
</table>
<h2><a href="#Fields">Fields</a></h2>
<table class="function_list">
	<tr>
	<td class="name" nowrap><a href="#duplex_preferences">duplex_preferences</a></td>
	<td class="summary">Global or configuration settings for Duplex</td>
	</tr>
	<tr>
	<td class="name" nowrap><a href="#button_hold_time">button_hold_time</a></td>
	<td class="summary">(number) the seconds required to trigger <code>DEVICE<em>EVENT.BUTTON</em>HELD</code>
 fractional values are supported, 0.5 is half a second</td>
	</tr>
	<tr>
	<td class="name" nowrap><a href="#slider_acceleration">slider_acceleration</a></td>
	<td class="summary">(number) the amount of acceleration applied to relative motion
 higher values equal less acceleration (default is 10)</td>
	</tr>
	<tr>
	<td class="name" nowrap><a href="#extrapolation_strength">extrapolation_strength</a></td>
	<td class="summary">(number) the amount of extrapolation applied to automation</td>
	</tr>
	<tr>
	<td class="name" nowrap><a href="#display_browser_on_start">display_browser_on_start</a></td>
	<td class="summary">(bool) when enabled, the Duplex browser is displayed on startup</td>
	</tr>
	<tr>
	<td class="name" nowrap><a href="#dump_midi">dump_midi</a></td>
	<td class="summary">(bool) dump MIDI messages to sdt out (Renoise terminal)</td>
	</tr>
	<tr>
	<td class="name" nowrap><a href="#dump_osc">dump_osc</a></td>
	<td class="summary">(bool) dump OSC messages to sdt out (Renoise terminal)</td>
	</tr>
	<tr>
	<td class="name" nowrap><a href="#osc_server_host">osc_server_host</a></td>
	<td class="summary">(string) the internal OSC connection (disabled if no host/port is specified)</td>
	</tr>
	<tr>
	<td class="name" nowrap><a href="#osc_server_port">osc_server_port</a></td>
	<td class="summary">(int) the internal OSC port address
 (set this to whatever the renoise OSC server is set to)</td>
	</tr>
	<tr>
	<td class="name" nowrap><a href="#osc_first_run">osc_first_run</a></td>
	<td class="summary">(bool) when OSC is being run the first time, display a message</td>
	</tr>
</table>

<br/>
<br/>


    <h2><a name="Tables"></a>Tables</h2>
    <dl class="function">
    <dt>
    <a name = "theme_color"></a>
    <strong>theme_color</strong>
    </dt>
    <dd>
    (table) theming support: specify the default button color


    <h3>Fields:</h3>
    <ul>
        <li><span class="parameter">red</span>
         0xc1
        </li>
        <li><span class="parameter">blue</span>
         0x34
        </li>
        <li><span class="parameter">green</span>
         0x11
        </li>
    </ul>





</dd>
</dl>
    <h2><a name="Fields"></a>Fields</h2>
    <dl class="function">
    <dt>
    <a name = "duplex_preferences"></a>
    <strong>duplex_preferences</strong>
    </dt>
    <dd>
    Global or configuration settings for Duplex







</dd>
    <dt>
    <a name = "button_hold_time"></a>
    <strong>button_hold_time</strong>
    </dt>
    <dd>
    (number) the seconds required to trigger <code>DEVICE<em>EVENT.BUTTON</em>HELD</code>
 fractional values are supported, 0.5 is half a second







</dd>
    <dt>
    <a name = "slider_acceleration"></a>
    <strong>slider_acceleration</strong>
    </dt>
    <dd>
    (number) the amount of acceleration applied to relative motion
 higher values equal less acceleration (default is 10)







</dd>
    <dt>
    <a name = "extrapolation_strength"></a>
    <strong>extrapolation_strength</strong>
    </dt>
    <dd>
    (number) the amount of extrapolation applied to automation







</dd>
    <dt>
    <a name = "display_browser_on_start"></a>
    <strong>display_browser_on_start</strong>
    </dt>
    <dd>
    (bool) when enabled, the Duplex browser is displayed on startup







</dd>
    <dt>
    <a name = "dump_midi"></a>
    <strong>dump_midi</strong>
    </dt>
    <dd>
    (bool) dump MIDI messages to sdt out (Renoise terminal)







</dd>
    <dt>
    <a name = "dump_osc"></a>
    <strong>dump_osc</strong>
    </dt>
    <dd>
    (bool) dump OSC messages to sdt out (Renoise terminal)







</dd>
    <dt>
    <a name = "osc_server_host"></a>
    <strong>osc_server_host</strong>
    </dt>
    <dd>
    (string) the internal OSC connection (disabled if no host/port is specified)







</dd>
    <dt>
    <a name = "osc_server_port"></a>
    <strong>osc_server_port</strong>
    </dt>
    <dd>
    (int) the internal OSC port address
 (set this to whatever the renoise OSC server is set to)







</dd>
    <dt>
    <a name = "osc_first_run"></a>
    <strong>osc_first_run</strong>
    </dt>
    <dd>
    (bool) when OSC is being run the first time, display a message







</dd>
</dl>


</div> <!-- id="content" -->
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.2</a></i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
</html>
